<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class planets | PhpProject1</title>

	<script type="text/javascript" src="resources/combined.js?2802348487"></script>
	<script type="text/javascript" src="elementlist.js?1053356144"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
		</div>



		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-deposits.html">deposits</a></li>
				<li class="active"><a href="class-planets.html">planets</a></li>
				<li><a href="class-terrain.html">terrain</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class planets</h1>


	<div class="description">
	
<p>The planets class holds all of the functions related to planets IE:
Creating/Editing them, displaying them.</p>

	</div>









	<div class="info">
		
		
		
		

				<b>Author:</b>
				Charles<br />
		<b>Located at</b> <a href="source-class-planets.html#3-307" title="Go to source code">library/planets.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="createPlanet" id="_createPlanet">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_createPlanet">#</a>
		<code><a href="source-class-planets.html#11-68" title="Go to source code">createPlanet</a>( <span>mixed <var>$name</var></span>, <span>integer <var>$size</var></span> )</code>

		<div class="description short">
			
<p>Creates a planet,.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Creates a planet,.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>mixed</code><br>$name</dd>
					<dt><var>$size</var></dt>
					<dd><code>integer</code><br>$size</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code></code><br>Function returns nothing, redirects user.<br />
				</div>


				<h4>Author</h4>
				<div class="list">
						Charles Nicholson<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="listPlanets" id="_listPlanets">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_listPlanets">#</a>
		<code><a href="source-class-planets.html#70-104" title="Go to source code">listPlanets</a>( )</code>

		<div class="description short">
			
<p>Lists planets in a nice div.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Lists planets in a nice div.</p>




				<h4>Returns</h4>
				<div class="list">
					<code></code><br>Echo's HTML.<br />
				</div>


				<h4>Author</h4>
				<div class="list">
						Charles Nicholson<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="countDeposits" id="_countDeposits">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_countDeposits">#</a>
		<code><a href="source-class-planets.html#106-124" title="Go to source code">countDeposits</a>( <span>integer <var>$planetID</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			
<p>Description: Returns how many deposits per planet</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="planetInfo" id="_planetInfo">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_planetInfo">#</a>
		<code><a href="source-class-planets.html#126-154" title="Go to source code">planetInfo</a>( <span>integer <var>$planetID</var></span>, <span>string <var>$name</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Description: Searches and returns planet info, by name or ID.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Description: Searches and returns planet info, by name or ID.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="editPlanet" id="_editPlanet">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_editPlanet">#</a>
		<code><a href="source-class-planets.html#156-254" title="Go to source code">editPlanet</a>( <span>integer <var>$planetID</var></span>, <span>string <var>$name</var></span>, <span>integer <var>$size</var></span>, <span>string <var>$coordinates</var></span>, <span>integer <var>$type</var></span> )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name</dd>
					<dt><var>$size</var></dt>
					<dd><code>integer</code><br>$size</dd>
					<dt><var>$coordinates</var></dt>
					<dd><code>string</code><br>$coordiantes</dd>
					<dt><var>$type</var></dt>
					<dd><code>integer</code><br>$type</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code></code><br>Updates database,<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getPlanets" id="_getPlanets">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getPlanets">#</a>
		<code><a href="source-class-planets.html#257-273" title="Go to source code">getPlanets</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			



				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="planetCount" id="_planetCount">

		<td class="attributes"><code>
			 public 
			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_planetCount">#</a>
		<code><a href="source-class-planets.html#275-289" title="Go to source code">planetCount</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			



				<h4>Returns</h4>
				<div class="list">
					<code>integer</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="deletePlanet" id="_deletePlanet">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_deletePlanet">#</a>
		<code><a href="source-class-planets.html#292-306" title="Go to source code">deletePlanet</a>( <span>integer <var>$planetID</var></span> )</code>

		<div class="description short">
			
<p>Descripion: Deletes planet from db where planetid = id</p>

		</div>

		<div class="description detailed hidden">
			
<p>Descripion: Deletes planet from db where planetid = id</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$planetID</var></dt>
					<dd><code>integer</code><br>$planetID</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	</table>


















</div>

	<div id="footer">
		PhpProject1 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
